Перейти к основному содержимому

Style guide

feature/ – для новых функций
fix/ – для исправлений
hotfix/ – для срочных исправлений
chore/ – для технических задач, не связанных с логикой приложения
refactoring/ – для улучшения кода без изменения функциональности
test/ – для тестирования
docs/ – для обновления документации
release/ – для подготовки релизов
experiment/ – для экспериментальных изменений

Наименование веток​

ITR-#\_prefix/description
примеры
ITR-91_feature/partner-pages
ITR-105_chore/move-button

Коммиты​

[ITR-#] prefix: description
примеры
[ITR-91] feature: add partner page and form add new partner
[ITR-105] chore: move button change password

Наименование путей в АПИ​

Route формируется из следующих частей:
Схема в БД
+ Главная сущность (если есть)
+ Id главной сущности (если есть)
+ Сущность к которой обращаемся
+ id сущности или признак по которой происходи выборка
+ Для чего предпологается использовать результат (

  • 'table' специальная компановка для таблицы
  • 'list' - для выпадающих списков - содержит 2-3 поля - id, name, возможное дополнительное
  • 'all' - для всего - обычно для справочных единиц у которых всего 2-3 поля
  • без дополнения, если возвращается одна сущность
  • 'full' - устаревшее, больше не использовать - текущая сущность и все связанные
  • уникальное действие - изменить исполнителя )

Например:

  • GET /Order+/Partner+/Our+/list
  • GET /Order+/Partner+/{partnerId}+/BankingDetail+/{detailId}
  • PUT /Order+/BuyerOrder+/{id}+/responsible
  • POST /Order+/BuyerOrder+/{parentId}+/Good+/Task+/{taskId}+/CreateBuyerOrder

Наименование экшенов обращений к АПИ​

Наименование формируется следующим образом:
Тип запроса (fetch, create, edit, delete)
+ Дополнительная информация (если есть)
+ Название сущности
+ Назначение ('table' для таблицы, 'list' для выпадающего списка, 'all' для всего. Можно ориентироваться на url)
+ ById (если есть хоть один).

Например:

  • fetch+Our+Partner+List - GET /Order/Partner/Our/list
  • fetch+Contract+Table+ById - GET /Order/Partner/{partnerId}/Contract/table
  • fetch+LegalForm+All - GET /Order/LegalForm/all
  • fetch+Partner+ContactPerson+List+ById - GET /Order/Partner/{partnerId}/ContactPerson/list
  • create+BankingDetail+ById - POST /Order/Partner/{partnerId}/BankingDetail
  • delete+BankingDetail+ById - DELETE /Order/Partner/{partnerId}/BankingDetail/{detailId}